home *** CD-ROM | disk | FTP | other *** search
/ Il Mio Computer 2004 August / GMC GIOCHI PER IL MIO COMPUTER - 2004 AGOSTO DVD.iso / patch / IL2 / patchil2_aep_201.exe / DeviceLink.txt < prev    next >
Encoding:
Text File  |  2004-04-21  |  12.1 KB  |  697 lines

  1.  
  2. The DeviceLink interface is meant to provide the third-party software with the
  3. current condition of the player's aircraft as well as allow an unified method of
  4. connecting alternative operating controls.
  5.  
  6. DeviceLink utilizes the UDP protocol to transfer the data. In this network, IL2
  7. plays a part of the server. The external application sends a query packet, in
  8. reply, IL2 sends back one (or several) packets containing the query result.
  9. Proposing using the protocol within a single computer, ar a local network, no
  10. data encoding is used and data integrity CRC-checks are not taken. Packets do
  11. contain only symbolic information, the allowed range is (0x21-0x7e). A query
  12. packet is preceded with an 'R' symbol, the resulting packed is preceded with an
  13. 'A'; followed by one or several "key"/"value" pairs. The "key" is the number
  14. identifying a parameter. The "value" may be omitted or consist of a number of
  15. copies. The semantics of the "value" depends on the parameter itself. The "keys"
  16. are preceded with a '/', the "values" are preceded with a '\'. If a "value" is
  17. to contain one of these symbols, it is preceded with a '\'. There are two types
  18. of "keys" - (get) requiring to return the value of the given parameter, and
  19. (set) setting the given parameter. The (get) keys are even while the latter ones
  20. are odd. "Get-keys" may contain values for the specified parameter, the answer
  21. packet returns the "value" with the "get-key". "Set-keys" may contain values for
  22. the parameter, but with these the reply contains none.
  23.  
  24. Ex.:
  25.  
  26. key 40 - altimeter
  27. key 81 - power
  28. Query packet           - R/40/81\1.6e-1
  29.   Return the aircraft altitude, and set the power to 1.6e-1.
  30. Reply (answer) packet  - A/40\534.3
  31.   Returns the current altitude 534.3 meters MSL.
  32.  
  33. The DeviceLink interface is activated if the [DeviceLink] section is found in the
  34. conf.ini file. Within this section, "port" specifies the number of UDP port for
  35. data transfer.
  36. Using "host" parameter one can specify the address of the network interface in
  37. use.
  38. The "IPS" parameter restricts the allowed client IP addresses. If the "IPS"
  39. parameter is not found in the section, any IP address is allowed to connect.
  40.  
  41. Ex.:
  42.  
  43. [DeviceLink]
  44. port=10000
  45. IPS=10.1.1.3 10.1.1.8
  46.  
  47. Port number is 10000, allowed clients are 10.1.1.3 and 10.1.1.8.
  48.  
  49.  
  50.  
  51. 1. Parameters - common.
  52.  
  53.  
  54.  
  55. Version
  56.   2   get() 
  57.       return: string containing DeviceLink version id.
  58.  
  59. accessible get
  60.   4   get(parameter key)
  61.       return: parameter key and 1 or 0 - wheither this key has get method
  62.               allowed in the current context (I.e. allowed during the mission
  63.               but not while mission is loading).
  64.  
  65. accessible set
  66.   6   get(parameter key)
  67.       return: parameter key and 1 or 0 - wheither this parameter has set method
  68.               allowed.
  69.  
  70. time of day
  71.   20  get()
  72.       return: float[hours] - current tome of the day within the game.
  73.  
  74. plane
  75.   22  get()
  76.       return: string identifying the player plane.
  77.  
  78. cockpits
  79.   24  get()
  80.       return: int, quantity of cockpits in the player aircraft.
  81.  
  82. cockpit cur
  83.   26  get()
  84.       return: int, number of the cockpit the player is currently in, starting
  85.               with 0. The cockpit # 0 is always the pilot in command's cockpit.
  86.               Returns -1 if the camera is on an external view.
  87.  
  88. engines
  89.   28  get()
  90.       return: int, quantity of engines on the player aircraft.
  91.  
  92.  
  93.  
  94. 2. Parameters - instruments readings.
  95.  
  96.  
  97.  
  98. In current version, this section is disabled while playing the game over the
  99. net.
  100.  
  101. speedometer_indicated 
  102.   30  get()
  103.       return: float [km/h]      +0.00   +inf
  104.  
  105. variometer            
  106.   32  get()
  107.       return: float [m/s]       -inf    +inf
  108.  
  109. slip                  
  110.   34  get()
  111.       return: float [deg.]      -45.00  +45.00
  112.  
  113. turn
  114.   36  get()
  115.       return: float [undefined] -1.00   +1.00
  116.               turn indicator
  117.  
  118. angular_speed         
  119.   38  get()
  120.       return: float [deg./s]    -inf    +inf
  121.  
  122. altimeter             
  123.   40  get()
  124.       return: float [m]         +0.00   +inf
  125.  
  126. azimuth               
  127.   42  get()
  128.       return: float [deg.]      +0.00   +359.(9)
  129.  
  130. beacon_azimuth        
  131.   44  get()
  132.       return: float [deg.]      +0.00   +359.(9)
  133.  
  134. roll                  
  135.   46  get()
  136.       return: float [deg.]      -180.00 +180.00
  137.  
  138. pitch                 
  139.   48  get()
  140.       return: float [deg.]      -90.00  +90.00
  141.  
  142. fuel
  143.   50  get()
  144.       return: float [kg.]      +0.00   +inf
  145.  
  146. overload              
  147.   52  get()
  148.       return: float [undefined] -inf    +inf
  149.  
  150. shake_level           
  151.   54  get()
  152.       return: float [undefined] +0.00   +1.00
  153.  
  154. gear_pos_l
  155.   56  get()
  156.       return: float [undefined] +0.00   +1.00
  157.               left gear "leg" position
  158.  
  159. gear_pos_r
  160.   58  get()
  161.       return: float [undefined] +0.00   +1.00
  162.               right gear "leg" position
  163.  
  164. gear_pos_c
  165.   60  get()
  166.       return: float [undefined] +0.00   +1.00
  167.               central gear position
  168.  
  169. magneto               
  170.   62  get(int - engine idx)
  171.       return: int   [undefined] +0      +3
  172.  
  173. rpm                   
  174.   64  get(int - engine idx)
  175.       return: float [rpm]       +0.00   +inf
  176.  
  177. manifold              
  178.   66  get(int - engine idx)
  179.       return: float [bar]       +0.00   +inf
  180.  
  181. temp_oilin            
  182.   68  get(int - engine idx)
  183.       return: float [deg.C]     -273.00 +inf
  184.  
  185. temp_oilout           
  186.   70  get(int - engine idx)
  187.       return: float [deg.C]     -273.00 +inf
  188.  
  189. temp_water            
  190.   72  get(int - engine idx)
  191.       return: float [deg.C]     -273.00 +inf
  192.  
  193. temp_cylinders        
  194.   74  get(int - engine idx)
  195.       return: float [deg.C]     -273.00 +inf
  196.  
  197.  
  198.  
  199. 3. Parameters - controls.
  200.  
  201.  
  202.  
  203. 3.1. Analog controls (joy axis).
  204. "Value" is limited to -1.00 +1.00.
  205.  
  206.  
  207.  
  208. Power
  209.   80  get() return: float
  210.   81  set(float)
  211.  
  212. Flaps 
  213.   82  get() return: float
  214.   83  set(float)
  215.  
  216. Aileron      
  217.   84  get() return: float
  218.   85  set(float)
  219.  
  220. Elevator     
  221.   86  get() return: float
  222.   87  set(float)
  223.  
  224. Rudder       
  225.   88  get() return: float
  226.   89  set(float)
  227.  
  228. Brakes       
  229.   90  get() return: float
  230.   91  set(float)
  231.  
  232. Prop Pitch        
  233.   92  get() return: float
  234.   93  set(float)
  235.  
  236. Aileron Trim
  237.   94  get() return: float
  238.   95  set(float)
  239.  
  240. Elevator Trim
  241.   96  get() return: float
  242.   97  set(float)
  243.  
  244. Rudder Trim
  245.   98  get() return: float
  246.   99  set(float)
  247.  
  248.  
  249.  
  250. 3.2. Discontinuous.
  251. If the set method contains no value, calling it is equal to depressing the
  252. corresponding hotkey once.
  253.  
  254.  
  255.  
  256. Level Stabilizer
  257.  100  get() return: 1 or 0
  258.  101  set()
  259.  
  260. Toggle Engine
  261.  103  set()
  262.  
  263. Boost (WEP) On/Off
  264.  104  get() return: 1 or 0
  265.  105  set()
  266.  
  267. Magneto Next
  268.  106  get() return: int 0 - 3
  269.  107  set()
  270.  
  271. Magneto Prev.
  272.  108  get() return: int 0 - 3
  273.  109  set()
  274.  
  275. Supercharger Next Stage
  276.  110  get() return: int
  277.  111  set()
  278.  
  279. Supercharger Prev. Stage
  280.  112  get() return: int
  281.  113  set()
  282.  
  283. Select All Engines
  284.  115  set()
  285.  
  286. Unselect All Engines
  287.  117  set()
  288.  
  289. Select Left Engines
  290.  119  set()
  291.  
  292. Select Right Engines 
  293.  121  set()
  294.  
  295. Select Engine #1
  296.  123  set()
  297.  
  298. Select Engine #2
  299.  125  set()
  300.  
  301. Select Engine #3
  302.  127  set()
  303.  
  304. Select Engine #4
  305.  129  set()
  306.  
  307. Select Engine #5
  308.  131  set()
  309.  
  310. Select Engine #6
  311.  133  set()
  312.  
  313. Select Engine #7
  314.  135  set()
  315.  
  316. Select Engine #8
  317.  137  set()
  318.  
  319. Toggle Selection for All Engines
  320.  139  set()
  321.  
  322. Toggle Left Engines
  323.  141  set()
  324.  
  325. Toggle Right Engines
  326.  143  set()
  327.  
  328. Select/Unselect Engine #1
  329.  145  set()
  330.  
  331. Select/Unselect Engine #2
  332.  147  set()
  333.  
  334. Select/Unselect Engine #3
  335.  149  set()
  336.  
  337. Select/Unselect Engine #4
  338.  151  set()
  339.  
  340. Select/Unselect Engine #5
  341.  153  set()
  342.  
  343. Select/Unselect Engine #6
  344.  155  set()
  345.  
  346. Select/Unselect Engine #7
  347.  157  set()
  348.  
  349. Select/Unselect Engine #8
  350.  159  set()
  351.  
  352. Fire Extinguisher
  353.  161  set()
  354.  
  355. Feather Prop.
  356.  162  get() return: int
  357.  163  set()
  358.  
  359. Gear Up/Down
  360.  164  get() return: float
  361.  165  set()
  362.  
  363. Rise Gear manually
  364.  167  set()
  365.  
  366. Lower Gear manually
  367.  169  set()
  368.  
  369. Cowl or Armor Flaps
  370.  171  set()
  371.  
  372. Airbrake
  373.  172  get() return: int 0 - 1
  374.  173  set()
  375.  
  376. Lock Tail Wheel
  377.  174  get() return: int 0 - 1
  378.  175  set()
  379.  
  380. Jettison Droptanks
  381.  177  set()
  382.  
  383. Attach/Detach Aircraft
  384.  179  set()
  385.  
  386. Weapon 1
  387.  180  get() return: int 0 - 1
  388.  181  set(int) 1 - start 0 - stop
  389.  
  390. Weapon 2
  391.  182  get() return: int 0 - 1
  392.  183  set(int) 1 - start 0 - stop
  393.  
  394. Weapon 3
  395.  184  get() return: int 0 - 1
  396.  185  set(int) 1 - start 0 - stop
  397.  
  398. Weapon 4
  399.  186  get() return: int 0 - 1
  400.  187  set(int) 1 - start 0 - stop
  401.  
  402. Weapon 1+2
  403.  188  get() return: int 0 - 1
  404.  189  set(int) 1 - start 0 - stop
  405.  
  406. Toggle Gun Pods On/Off
  407.  190  get() return: int 0 - 1
  408.  191  set()
  409.  
  410. Toggle Sight Mode (Auto)
  411.  193  set()
  412.  
  413. Increase Sight Distance
  414.  195  set()
  415.  
  416. Decrease Sight Distance
  417.  197  set()
  418.  
  419. Adjust Sight Control to Right
  420.  199  set()
  421.  
  422. Adjust Sight Control to Left  
  423.  201  set()
  424.  
  425. Increase Sight Altitude
  426.  203  set()
  427.  
  428. Decrease Sight Altitude
  429.  205  set()
  430.  
  431. Increase Sight Velocity  
  432.  207  set()
  433.  
  434. Decrease Sight Velocity
  435.  209  set()
  436.  
  437. Gunner Fire
  438.  220  get() return: int 0 - 1
  439.  221  set(int) 1 - start 0 - stop
  440.  
  441. Gunner Move
  442.  223  set(int,int,int)
  443.       Increment of mouse movement along the 3 axis. The third one is not used
  444.       currently.
  445.  
  446.  
  447.  
  448. 4. Parameters - camera control.
  449.  
  450.  
  451.  
  452. 4.1. Discontinuous.
  453. If the set method contains no value, calling it is equal to depressing the
  454. corresponding hotkey once.
  455.  
  456.  
  457.  
  458. Pilot or Gunner Position
  459.   300 get() return: int current player cockpit idx
  460.   301 set()
  461.  
  462. Jump to Cockpit #1 (Pilot)
  463.   303 set()
  464.  
  465. Jump to Cockpit #2
  466.   305 set()
  467.  
  468. Jump to Cockpit #3
  469.   307 set()
  470.  
  471. Jump to Cockpit #4
  472.   309 set()
  473.  
  474. Jump to Cockpit #5
  475.   311 set()
  476.  
  477. Jump to Cockpit #6
  478.   313 set()
  479.  
  480. Jump to Cockpit #7
  481.   315 set()
  482.  
  483. Jump to Cockpit #8
  484.   317 set()
  485.  
  486. Jump to Cockpit #9
  487.   319 set()
  488.  
  489. Jump to Cockpit #10
  490.   321 set()
  491.  
  492. FOV 90
  493.   323 set()
  494.  
  495. FOV 85
  496.   325 set()
  497.  
  498. FOV 80
  499.   327 set()
  500.  
  501. FOV 75
  502.   329 set()
  503.  
  504. FOV 70
  505.   331 set()
  506.  
  507. FOV 65
  508.   333 set()
  509.  
  510. FOV 60
  511.   335 set()
  512.  
  513. FOV 55
  514.   337 set()
  515.  
  516. FOV 50
  517.   339 set()
  518.  
  519. FOV 45
  520.   341 set()
  521.  
  522. FOV 40
  523.   343 set()
  524.  
  525. FOV 35
  526.   345 set()
  527.  
  528. FOV 30
  529.   347 set()
  530.  
  531. Toggle FOV
  532.   348 get() return: float, current FOV, degrees.
  533.   349 set()
  534.  
  535. Increase FOV
  536.   351 set()
  537.  
  538. Decrease FOV
  539.   353 set()
  540.  
  541. Cockpit View
  542.   355 set()
  543.  
  544. No Cockpit View
  545.   357 set()
  546.  
  547. External View
  548.   359 set()
  549.  
  550. Next Friendly View
  551.   361 set()
  552.  
  553. Next Enemy View
  554.   363 set()
  555.  
  556. Fly-by View
  557.   365 set()
  558.  
  559. Padlock Enemy
  560.   367 set()
  561.  
  562. Padlock Friendly
  563.   369 set()
  564.  
  565. Padlock Enemy Ground
  566.   371 set()
  567.  
  568. Padlock Friendly Ground
  569.   373 set()
  570.  
  571. Padlock Next
  572.   375 set()
  573.  
  574. Padlock Previous
  575.   377 set()
  576.  
  577. Instant View Forward with Padlock
  578.   479 set(int) 1 - start 0 - stop
  579.  
  580. External Padlock, Enemy Air
  581.   381 set()
  582.  
  583. External Padlock, Friendly Air
  584.   383 set()
  585.  
  586. External Padlock, closest Enemy Air
  587.   385 set()
  588.  
  589. External Padlock, Enemy Ground
  590.   387 set()
  591.  
  592. External Padlock, Friendly Ground
  593.   389 set()
  594.  
  595. External Padlock, closest Enemy Ground
  596.   391 set()
  597.  
  598. Chase View
  599.   393 set()
  600.  
  601. Next Friendly Chase View
  602.   395 set()
  603.  
  604. Next Enemy Chase View
  605.   397 set()
  606.  
  607. Toggle Gunsight
  608.   399 set()
  609.  
  610.  
  611.  
  612. 4.2. Analogue.
  613.  
  614.  
  615.  
  616. TrackIR 
  617.    11 set(float,float,float) 
  618.       Sets the camera turn angles - yaw, pitch, and roll [deg.].
  619.       The roll param is ignored.
  620.  
  621.  
  622.  
  623. 5. Parameters - misc.
  624.  
  625.  
  626.  
  627. 5.1. Discontinuous.
  628. If the set method contains no value, calling it is equal to depressing the
  629. corresponding hotkey once.
  630.  
  631.  
  632.  
  633. Toggle Autopilot
  634.   401 set()
  635.  
  636. Toggle Level Autopilot
  637.   403 set()
  638.  
  639. Bail Out
  640.   405 set()
  641.  
  642. Tinted Reticle Dimmer (German Planes)
  643.   407 set()
  644.  
  645. Cockpit Lights
  646.   409 set()
  647.  
  648. Toggle Nav. Lights
  649.   411 set()
  650.  
  651. Toggle Landing Light
  652.   413 set()
  653.  
  654. Toggle Wingtip Smoke
  655.   415 set()
  656.  
  657. Toggle Map
  658.   417 set()
  659.  
  660. Chat
  661.   419 set()
  662.  
  663. Online Rating
  664.   421 set(int) 1 - show 0 - hide
  665.  
  666. Toggle Speed Bar
  667.   423 set()
  668.  
  669. Toggle Icon Types
  670.   425 set()
  671.  
  672. Toggle Mirrors Show/Mode
  673.   427 set()
  674.  
  675. Quick Start/Save Track
  676.   429 set()
  677.  
  678. Radio Mute Key
  679.   431 set(int) 1 - start 0 - stop
  680.  
  681. Radio Channel Switch
  682.   433 set()
  683.  
  684. Accelerate Time x2/x4/x8
  685.   435 set()
  686.  
  687. Normal Time
  688.   437 set()
  689.  
  690. Decelerate Time x2/x4
  691.   439 set()
  692.  
  693. PauseGame
  694.   441 set()
  695.  
  696.  
  697.